EstuaryClient.NetApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
adminMinersGet	GET /admin/miners/	Get all miners
publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
publicNetAddrsGet	GET /public/net/addrs	Net Addrs
publicNetPeersGet	GET /public/net/peers	Net Peers

adminMinersGet

ApiMinerResp adminMinersGet()

Get all miners

This endpoint returns all miners. Note: value may be cached

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.NetApi();
apiInstance.adminMinersGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ApiMinerResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

publicMinersFailuresMinerGet

'String' publicMinersFailuresMinerGet(miner)

Get all miners

This endpoint returns all miners

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.NetApi();
let miner = "miner_example"; // String | Filter by miner

apiInstance.publicMinersFailuresMinerGet(miner, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
miner	String	Filter by miner

Return type

'String'

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

publicNetAddrsGet

['String'] publicNetAddrsGet()

Net Addrs

This endpoint is used to get net addrs

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.NetApi();
apiInstance.publicNetAddrsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

publicNetPeersGet

['String'] publicNetPeersGet()

Net Peers

This endpoint is used to get net peers

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.NetApi();
apiInstance.publicNetPeersGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

['String']

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json